﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed

#pragma once

#include "ISurface.h"

namespace gcmp
{
    class Coordinate3d;

    /// \brief 球面
    class ISphere : public ISurface
    {
        DEFINE_CAST_DERIVED(gcmp::ISphere, gcmp::ISurface);

    public:
       /// \brief  创建球面（使用圆心，半径，世界坐标轴构造一个整球）
       /// \param[in] center 球心
       /// \param[in] radius 球面半径
       /// \return  球面
        GCMP_GEOMETRY_INTERFACE_EXPORT static OwnerPtr<ISphere> Create(
            const Vector3d& center,
            double radius
        );

        /// \brief  创建球面（使用球面的局部坐标系，U和V向参数域和半径构建球面对象）
        /// \param[in] coordinate 坐标系，球心在原点，北极在 Z 轴正半轴上，0 度经线在 XOZ 平面上
        /// \param[in] limitU U向参数域，U的最小值大于等于0.0，U的最大值小于等于radius * 2PI
        /// \param[in] limitV V向参数域，V的最小值大于等于-radius * PI/2，V的最大值小于等于radius * PI/2
        /// \param[in] radius 球面半径
        /// \return  球面
        GCMP_GEOMETRY_INTERFACE_EXPORT static OwnerPtr<ISphere> Create(
            const Coordinate3d& coordinate,
            const Intervald &limitU,
            const Intervald &limitV,
            double radius
        );

    public:

        /// \brief  设置球心
        /// \param[in] center  球心坐标
        /// \return 成功返回true,否则返回false(默认返回True)
        virtual bool SetCenter(const Vector3d& center) = 0;

        /// \brief  获得球心
        /// \return  球心坐标
        virtual Vector3d GetCenter() const = 0;

        /// \brief  设置球面坐标系
        /// \param[in] coordinate  坐标系
        /// \return 成功返回true,否则返回false(默认返回True)
        virtual bool SetCoordinate(const Coordinate3d& coordinate) = 0;

        /// \brief  获取球面坐标系
        /// \return  坐标系
        virtual Coordinate3d GetCoordinate() const = 0;

        /// \brief  设置U向参数域
        /// \param[in] limitU U向参数域，U的最小值大于等于0.0，U的最大值小于等于radius * 2PI
        /// \return 成功返回true,否则返回false(默认返回True)
        virtual bool SetLimitU(const Intervald& limitU) = 0;

        /// \brief  设置V向参数域
        /// \param[in] limitV V向参数域，V的最小值大于等于-radius * PI/2，V的最大值小于等于radius * PI/2
        /// \return 成功返回true,否则返回false(默认返回True)
        virtual bool SetLimitV(const Intervald& limitV) = 0;

        /// \brief  获得球面半径
        /// \return 球面半径
        virtual double GetRadius() const = 0;

    public:
        virtual ~ISphere() {}
    };
}
